kFbxClassId Class Reference

#include <kfbxplug.h>

List of all members.

---

Detailed Description

Base To define the ClassId of an object.

Remarks:

This class Id helps the FBX SDK identify the class hierarchy of plugs and objects. Each Plug is identified by a class id and a parent classId

Definition at line 60 of file kfbxplug.h.

Constructor and Destructor.
	kFbxClassId ()
	Constructor.
	kFbxClassId (const char *pClassName, const kFbxClassId &pParentClassId, kFbxPlugConstructor pConstructor=0, const char *pFBXType=NULL, const char *pFBXSubType=NULL)
	Constructor.
void	Destroy ()
	Delete this class id.
Public Member Functions
const char *	GetName () const
	Retrieve the class name.
kFbxClassId	GetParent () const
	Retrieve the parent class id.
KFbxPlug *	Create (KFbxSdkManager &pManager, const char *pName, const KFbxPlug *pFrom)
	Create a KFbxPlug from the specified KFbxPlug.
bool	Override (kFbxPlugConstructor pConstructor)
	Override the KFbxPlug constructor.
bool	Is (kFbxClassId const pId) const
	Test if this class is a hierarchical children of the specified class type.
bool	operator== (kFbxClassId const &pClassId) const
	Equivalence operator.
bool	operator!= (kFbxClassId const &pClassId) const
	Inequivalence operator.
KFbxClassIdInfo *	GetClassIdInfo ()
	Retrieve the information of this class id.
const KFbxClassIdInfo *	GetClassIdInfo () const
	Retrieve the information of this class id.
const char *	GetFbxFileTypeName (bool pAskParent=false) const
	Retrieve the fbx file type name.
const char *	GetFbxFileSubTypeName () const
	Retrieve the fbx file subtype name.
bool	IsValid () const
	Get whether this class type is valid.
void	SetObjectTypePrefix (const char *pObjectTypePrefix)
	Set object type prefix.
const char *	GetObjectTypePrefix ()
	Get object type prefix.
KFbxPropertyHandle *	GetRootClassDefaultPropertyHandle ()
	Get the default property handle of root class.
int	ClassInstanceIncRef ()
	Increase the instance reference count of this class type.
int	ClassInstanceDecRef ()
	Decrease the instance reference count of this class type.
int	GetInstanceRef ()
	Retrieve the instance reference count of this class type.
Friends
class	KFbxSdkManager

---

Constructor & Destructor Documentation

kFbxClassId

(

)

Constructor.

kFbxClassId	(	const char *	pClassName,
		const kFbxClassId &	pParentClassId,
		kFbxPlugConstructor	pConstructor = 0,
		const char *	pFBXType = NULL,
		const char *	pFBXSubType = NULL
	)

Constructor.

Parameters:

	pClassName	Class name.
	pParentClassId	Parent class id.
	pConstructor	Pointer to a function which constructs KFbxPlug.
	pFBXType	Fbx file type name.
	pFBXSubType	Fbx file subtype name.

---

Member Function Documentation

void Destroy

(

)

Delete this class id.

const char* GetName

(

)

const

Retrieve the class name.

Returns:

Class name.

kFbxClassId GetParent

(

)

const

Retrieve the parent class id.

Returns:

Parent class id.

KFbxPlug* Create	(	KFbxSdkManager &	pManager,
		const char *	pName,
		const KFbxPlug *	pFrom
	)

Create a KFbxPlug from the specified KFbxPlug.

Parameters:

	pManager	The object manager
	pName	KFbxPlug name
	pFrom	The specified KFbxPlug

Returns:

KFbxPlug

bool Override

(

kFbxPlugConstructor

pConstructor

)

Override the KFbxPlug constructor.

Parameters:

pConstructor

New KFbxPlug constructor.

bool Is

(

kFbxClassId const

pId

)

const

Test if this class is a hierarchical children of the specified class type.

Parameters:

pId

Representing the class type

Returns:

true if the object is a hierarchical children of the type specified, false otherwise.

bool operator==

(

kFbxClassId const &

pClassId

)

const

Equivalence operator.

Parameters:

pClassId

Another class id to be compared with this class id.

Returns:

true if equal, false otherwise.

bool operator!=

(

kFbxClassId const &

pClassId

)

const

Inequivalence operator.

Parameters:

pClassId

Another class id to be compared with this class id.

Returns:

true if inequal, false otherwise.

KFbxClassIdInfo* GetClassIdInfo

(

)

[inline]

Retrieve the information of this class id.

Returns:

the class information.

Definition at line 128 of file kfbxplug.h.

const KFbxClassIdInfo* GetClassIdInfo

(

)

const [inline]

Retrieve the information of this class id.

Returns:

the class information.

Definition at line 133 of file kfbxplug.h.

const char* GetFbxFileTypeName

(

bool

pAskParent = false

)

const

Retrieve the fbx file type name.

Parameters:

pAskParent

a flag on whether to ask the parent for file type name.

Returns:

the fbx file type name.

const char* GetFbxFileSubTypeName

(

)

const

Retrieve the fbx file subtype name.

bool IsValid

(

)

const [inline]

Get whether this class type is valid.

Returns:

true if valid, false otherwise.

Definition at line 158 of file kfbxplug.h.

void SetObjectTypePrefix

(

const char *

pObjectTypePrefix

)

Set object type prefix.

Parameters:

pObjectTypePrefix

object type prefix.

const char* GetObjectTypePrefix

(

)

Get object type prefix.

KFbxPropertyHandle* GetRootClassDefaultPropertyHandle

(

)

Get the default property handle of root class.

int ClassInstanceIncRef

(

)

Increase the instance reference count of this class type.

Returns:

the instance reference of this type after increase.

int ClassInstanceDecRef

(

)

Decrease the instance reference count of this class type.

Returns:

the instance reference of this type after decrease.

int GetInstanceRef

(

)

Retrieve the instance reference count of this class type.

Returns:

the instance reference of this type.

---

Friends And Related Function Documentation

friend class KFbxSdkManager [friend]

Definition at line 136 of file kfbxplug.h.